<!DOCTYPE html>
<html>
  <head>
    <meta charset='utf-8'>
    <meta content='width=device-width, initial-scale=1.0' name='viewport'>
    <meta content='' name='description'>
    <meta content='Nils Nordman' name='author'>
    <link href='/images/howl.png' rel='shortcut icon'>
    <title>Howl :: Spec - howl.interact</title>
    <link href="/stylesheets/bootstrap.min.css" media="screen" rel="stylesheet" type="text/css" />
    <link href="/stylesheets/syntax.css" media="screen" rel="stylesheet" type="text/css" />
    <link href="/stylesheets/howl.css" media="screen" rel="stylesheet" type="text/css" />
    <script src="https://code.jquery.com/jquery-1.12.3.min.js" type="text/javascript"></script>
    <script src="/javascripts/bootstrap.min.js" type="text/javascript"></script>
    
    <link href='//fonts.googleapis.com/css?family=Josefin+Slab' rel='stylesheet' type='text/css'>
    <link href='//fonts.googleapis.com/css?family=Open+Sans+Condensed:700' rel='stylesheet' type='text/css'>
  </head>
  <body class='doc doc_spec doc_spec_interact_spec'>
    <div class='container'>
      <div class='masthead'>
        <ul class='nav nav-pills'>
          <li>
            <a href='/'>
              <span class='glyphicon glyphicon-home'></span>
              Home
            </a>
          </li>
          <li>
            <a href='/doc/'>
              <span class='glyphicon glyphicon-book'></span>
              Documentation
            </a>
          </li>
          <li>
            <a href='/blog/'>
              <span class='glyphicon glyphicon-bullhorn'></span>
              Blog
            </a>
          </li>
          <li>
            <a href='/contact.html'>
              <span class='glyphicon glyphicon-inbox'></span>
              Contact
            </a>
          </li>
        </ul>
      </div>
      <ol class="breadcrumb"><li><a href="/">Home</a></li><li><a href='../'>Howl 0.4 Documentation</a></li><li>Spec</li><li>Spec - howl.interact</li></ol>
      <div class="spec-group spec-group-1">&#x000A;&#x000A;<h1 id="howl.interact">howl.interact</h1>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">run_in_coroutine</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">f</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">wrapped</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">coroutine.wrap</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">f</span><span class="o">!</span><span class="w">&#x000A;  </span><span class="k">return</span><span class="w"> </span><span class="n">wrapped</span><span class="o">!</span><span class="w">&#x000A;&#x000A;</span><span class="n">before_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="k">if</span><span class="w"> </span><span class="n">howl</span><span class="p">.</span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="w">&#x000A;    </span><span class="n">howl</span><span class="p">.</span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="p">.</span><span class="n">command_line</span><span class="o">\</span><span class="n">abort_all</span><span class="o">!</span><span class="w">&#x000A;  </span><span class="n">howl</span><span class="p">.</span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Window</span><span class="o">!</span><span class="w">&#x000A;&#x000A;</span><span class="n">after_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">howl</span><span class="p">.</span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="p">.</span><span class="n">command_line</span><span class="o">\</span><span class="n">abort_all</span><span class="o">!</span><span class="w">&#x000A;  </span><span class="n">howl</span><span class="p">.</span><span class="n">app</span><span class="p">.</span><span class="n">window</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">nil</span></pre>&#x000A;&#x000A;<h4 id=".unregister(name)-removes-the-specified-input">.unregister(name) removes the specified input</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">interact</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="ss">factory:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">true</span><span class="w">&#x000A;</span><span class="n">interact</span><span class="p">.</span><span class="n">unregister</span><span class="w"> </span><span class="s1">'foo'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">is_nil</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">foo</span></pre>&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h2 id=".register">.register<span class="arg-list">(spec)</span></h2>&#x000A;&#x000A;<h4 id="raises-an-error-if-any-of-the-mandatory-fields-are-missing">raises an error if any of the mandatory fields are missing</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'name'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="ss">factory:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">true</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'description'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="ss">factory:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">true</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'factory'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'foo'</span><span class="p">,</span><span class="w"> </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'foo'</span></pre>&#x000A;&#x000A;<h4 id="accepts-one-of-&quot;factory&quot;-or-&quot;handler&quot;">accepts one of &quot;factory&quot; or &quot;handler&quot;</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">assert</span><span class="p">.</span><span class="n">raises</span><span class="w"> </span><span class="s1">'factory'</span><span class="p">,</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">register</span><span class="w">&#x000A;  </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'foo'</span><span class="w">&#x000A;  </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'foo'</span><span class="w">&#x000A;  </span><span class="ss">factory:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">true</span><span class="w">&#x000A;  </span><span class="ss">handler:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="kc">true</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-2">&#x000A;&#x000A;<h3 id=")"><span class="arg-list">(calling an interaction .&lt;name&gt;(...)</span>)</h3>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">before_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">interact</span><span class="p">.</span><span class="n">register</span><span class="w">&#x000A;    </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'interaction_call'</span><span class="w">&#x000A;    </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'calls passed in function'</span><span class="w">&#x000A;    </span><span class="ss">handler:</span><span class="w"> </span><span class="p">(</span><span class="n">f</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">f</span><span class="o">!</span><span class="w">&#x000A;&#x000A;  </span><span class="n">interaction_instance</span><span class="w"> </span><span class="o">=</span><span class="w">&#x000A;    </span><span class="ss">run:</span><span class="w"> </span><span class="p">(</span><span class="vi">@finish</span><span class="p">,</span><span class="w"> </span><span class="n">f</span><span class="p">)</span><span class="w"> </span><span class="o">=&gt;</span><span class="w"> </span><span class="n">f</span><span class="p">(</span><span class="n">finish</span><span class="p">)</span><span class="w">&#x000A;&#x000A;  </span><span class="n">interact</span><span class="p">.</span><span class="n">register</span><span class="w">&#x000A;    </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'interaction_with_factory'</span><span class="p">,</span><span class="w">&#x000A;    </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'calls passed in function f(finish)'</span><span class="w">&#x000A;    </span><span class="ss">factory:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">moon</span><span class="p">.</span><span class="n">copy</span><span class="w"> </span><span class="n">interaction_instance</span><span class="w">&#x000A;&#x000A;</span><span class="n">after_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">interact</span><span class="p">.</span><span class="n">unregister</span><span class="w"> </span><span class="s1">'interaction_call'</span><span class="w">&#x000A;  </span><span class="n">interact</span><span class="p">.</span><span class="n">unregister</span><span class="w"> </span><span class="s1">'interaction_with_factory'</span></pre>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(..  for a spec with .handler)</span></h3>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="kd">local</span><span class="w"> </span><span class="n">i1_spec</span><span class="w">&#x000A;</span><span class="n">before_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">i1_spec</span><span class="w"> </span><span class="o">=</span><span class="w">&#x000A;    </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'interaction1'</span><span class="w">&#x000A;    </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'interaction with handler'</span><span class="w">&#x000A;    </span><span class="ss">handler:</span><span class="w"> </span><span class="n">spy</span><span class="p">.</span><span class="n">new</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="s1">'r1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'r2'</span><span class="w">&#x000A;  </span><span class="n">interact</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">i1_spec</span><span class="w">&#x000A;&#x000A;</span><span class="n">after_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">interact</span><span class="p">.</span><span class="n">unregister</span><span class="w"> </span><span class="n">i1_spec</span><span class="p">.</span><span class="n">name</span></pre>&#x000A;&#x000A;<h4 id="calls-the-interaction-handler(...),-returns-result">calls the interaction handler(...), returns result</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">multi_value</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">table.pack</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">interaction1</span><span class="w"> </span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">i1_spec</span><span class="p">.</span><span class="n">handler</span><span class="p">).</span><span class="n">was_called_with</span><span class="w"> </span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">is_same</span><span class="w"> </span><span class="p">{</span><span class="s1">'r1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'r2'</span><span class="p">,</span><span class="w"> </span><span class="ss">n:</span><span class="mi">2</span><span class="p">},</span><span class="w"> </span><span class="n">multi_value</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(..  for a spec with .factory)</span></h3>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="kd">local</span><span class="w"> </span><span class="n">i2_spec</span><span class="p">,</span><span class="w"> </span><span class="n">i2_interactor</span><span class="w">&#x000A;</span><span class="n">before_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">i2_interactor</span><span class="w"> </span><span class="o">=</span><span class="w">&#x000A;    </span><span class="ss">run:</span><span class="w"> </span><span class="n">spy</span><span class="p">.</span><span class="n">new</span><span class="w"> </span><span class="p">(</span><span class="vi">@finish</span><span class="p">,</span><span class="w"> </span><span class="o">...</span><span class="p">)</span><span class="w"> </span><span class="o">=&gt;</span><span class="w"> </span><span class="k">return</span><span class="w">&#x000A;  </span><span class="n">i2_spec</span><span class="w"> </span><span class="o">=</span><span class="w">&#x000A;    </span><span class="ss">name:</span><span class="w"> </span><span class="s1">'interaction2'</span><span class="w">&#x000A;    </span><span class="ss">description:</span><span class="w"> </span><span class="s1">'interaction with factory'</span><span class="w">&#x000A;    </span><span class="ss">factory:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">i2_interactor</span><span class="w">&#x000A;  </span><span class="n">interact</span><span class="p">.</span><span class="n">register</span><span class="w"> </span><span class="n">i2_spec</span><span class="w">&#x000A;&#x000A;</span><span class="n">after_each</span><span class="w"> </span><span class="o">-&gt;</span><span class="w">&#x000A;  </span><span class="n">interact</span><span class="p">.</span><span class="n">unregister</span><span class="w"> </span><span class="n">i2_spec</span><span class="p">.</span><span class="n">name</span></pre>&#x000A;&#x000A;<h4 id=".&lt;name&gt;(...)-invokes-the-interaction-method-run(finish,-...)">.&lt;name&gt;(...) invokes the interaction method run(finish, ...)</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">run_in_coroutine</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="nb">table.pack</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">interaction2</span><span class="w"> </span><span class="s1">'arg1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'arg2'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">spy</span><span class="p">(</span><span class="n">i2_interactor</span><span class="p">.</span><span class="n">run</span><span class="p">).</span><span class="n">was_called</span><span class="w"> </span><span class="mi">1</span></pre>&#x000A;&#x000A;<h4 id=".&lt;name&gt;(...)-returns-results-passed-via-finish(...)">.&lt;name&gt;(...) returns results passed via finish(...)</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="n">multi_value</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kc">nil</span><span class="w">&#x000A;</span><span class="n">run_in_coroutine</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">multi_value</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">table.pack</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">interaction2</span><span class="o">!</span><span class="w">&#x000A;</span><span class="n">i2_interactor</span><span class="p">.</span><span class="n">finish</span><span class="w"> </span><span class="s1">'r1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'r2'</span><span class="w">&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">is_same</span><span class="w"> </span><span class="p">{</span><span class="s1">'r1'</span><span class="p">,</span><span class="w"> </span><span class="s1">'r2'</span><span class="p">,</span><span class="w"> </span><span class="ss">n:</span><span class="mi">2</span><span class="p">},</span><span class="w"> </span><span class="n">multi_value</span></pre>&#x000A;</div>&#x000A;<div class="spec-group spec-group-3">&#x000A;&#x000A;<h3 id=""><span class="arg-list">(..  nested transactions)</span></h3>&#x000A;&#x000A;<h4 id="raises-an-error-when-attempting-to-finishing-not-active-interaction">raises an error when attempting to finishing not active interaction</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="kd">local</span><span class="w"> </span><span class="n">captured_finish</span><span class="w">&#x000A;</span><span class="n">capture_finish</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">finish</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">captured_finish</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">finish</span><span class="w">&#x000A;&#x000A;</span><span class="n">run_in_coroutine</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">interaction_with_factory</span><span class="w"> </span><span class="n">capture_finish</span><span class="w">&#x000A;</span><span class="n">finish1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">captured_finish</span><span class="w">&#x000A;</span><span class="n">finish1</span><span class="o">!</span><span class="w">&#x000A;&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">has_error</span><span class="w"> </span><span class="n">finish1</span><span class="p">,</span><span class="w"> </span><span class="s1">'Cannot finish - no running activities'</span></pre>&#x000A;&#x000A;<h4 id="allows-cancelling-outer-interactions,-when-nested-interactions-present">allows cancelling outer interactions, when nested interactions present</h4>&#x000A;&#x000A;<pre class="highlight moonscript"><span class="kd">local</span><span class="w"> </span><span class="n">captured_finish</span><span class="w">&#x000A;</span><span class="n">capture_finish</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">finish</span><span class="p">)</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">captured_finish</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">finish</span><span class="w">&#x000A;&#x000A;</span><span class="n">run_in_coroutine</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">interaction_with_factory</span><span class="w"> </span><span class="n">capture_finish</span><span class="w">&#x000A;</span><span class="n">run_in_coroutine</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="n">interact</span><span class="p">.</span><span class="n">interaction_with_factory</span><span class="w"> </span><span class="n">capture_finish</span><span class="w">&#x000A;</span><span class="n">finish2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">captured_finish</span><span class="w">&#x000A;&#x000A;</span><span class="n">assert</span><span class="p">.</span><span class="n">has_no_error</span><span class="w"> </span><span class="n">finish2</span></pre>&#x000A;</div>&#x000A;</div>&#x000A;</div>
      <div class='footer text-muted'>
        <a href='/'>
          <img width="50" height="50" class="footer-logo" src="/images/howl.png" />
        </a>
        <div class='footer-follow'>
          <p>
            <a class='twitter-follow-button' data-lang='en' data-show-count='false' href='https://twitter.com/howleditor' rel='me'>
              Follow @howleditor
            </a>
          </p>
          <p>
            <a class='twitter-share-button' data-count='none' data-hashtags='howleditor' data-lang='en' data-text='The Howl Editor, a general purpose, light-weight customizable editor.' data-url='http://howl.io' href='https://twitter.com/share'>
              Tweet
            </a>
          </p>
        </div>
        <div class='footer-blurb'>
          <div>The Howl editor.</div>
          <div>
            Copyright 2012-2016
            <a class='alert-link' href='https://github.com/howl-editor/howl/contributors'>
              The Howl Developers.
            </a>
          </div>
        </div>
      </div>
    </div>
    <script>
      <!-- / GA -->
      (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
      (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
      })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
      ga('create', 'UA-45283282-1', 'howl.io');
      ga('send', 'pageview');
      <!-- / Twitter -->
      !function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];
      if(!d.getElementById(id)){js=d.createElement(s);js.id=id;
      js.src="//platform.twitter.com/widgets.js";
      fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");
    </script>
  </body>
</html>
